API

Logistics APIs

GET logistics/assignment-registers/{assignmentRegisterId}/assignments/{assignmentId}

Details about the specific assignment in the assigment register

HTTP method GET
URI https://api.rambase.net/logistics/assignment-registers/{assignmentRegisterId}/assignments/{assignmentId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {assignmentRegisterId} Assignment register identifier
Integer, minimum 100000
- URI parameter {assignmentId} Allocation identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 2067, version 7

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Assignment>
2
     <AssignmentId
AssignmentId

Allocation identifier

>
{Integer}</AssignmentId>
3
     <Quantity
Quantity

Quantity assigned

>
{Decimal}</Quantity>
4
     <CreatedAt
CreatedAt

Date and time of creation

>
{Datetime}</CreatedAt>
5
     <AssignedBy>
6
          <UserId
UserId

User identifier

>
{Integer}</UserId>
7
          <UserLink
UserLink

User reference

>
{String}</UserLink>
8
     </AssignedBy>
9
     <AssignedTo>
10
          <Database
Database

Database of the object

>
{String}</Database>
11
          <ObjectId
ObjectId

Identifier of the object

>
{Integer}</ObjectId>
12
          <ObjectType
ObjectType

Type of object

>
{String}</ObjectType>
13
          <ObjectLink
ObjectLink

API reference to the object

>
{String}</ObjectLink>
14
          <ItemId
ItemId

Item-number of the object

>
{Integer}</ItemId>
15
          <ItemType
ItemType

Type of item

>
{String}</ItemType>
16
          <ItemLink
ItemLink

API reference to the item

>
{String}</ItemLink>
17
          <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>
{String}</RamBaseKey>
18
     </AssignedTo>
19
     <ProductStructureAssignment
ProductStructureAssignment

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

>
20
          <ProductStructureMaterial
ProductStructureMaterial

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

>
21
               <ProductStructureMaterialId
ProductStructureMaterialId

Product structure material identifier

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

>
{Integer}</ProductStructureMaterialId>
22
               <ProductStructureOperation
ProductStructureOperation

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

>
23
                    <SequenceNumber
SequenceNumber

Sequence number of the product structure operation. Unique within a product structure.

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

>
{Integer}</SequenceNumber>
24
               </ProductStructureOperation>
25
               <ProductStructure
ProductStructure

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

>
26
                    <ProductStructureId
ProductStructureId

Assignment register identifier

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

>
{Integer}</ProductStructureId>
27
                    <ProductStructureLink
ProductStructureLink

Assignment register identifier

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

>
{String}</ProductStructureLink>
28
               </ProductStructure>
29
               <ProductStructureMaterialLink
ProductStructureMaterialLink

Product structure material reference

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

>
{String}</ProductStructureMaterialLink>
30
          </ProductStructureMaterial>
31
          <ProductStructureOperation
ProductStructureOperation

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

>
32
               <ProductStructureOperationId
ProductStructureOperationId

Product structure operation identifier

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

>
{Integer}</ProductStructureOperationId>
33
               <SequenceNumber
SequenceNumber

Sequence number of the product structure operation. Unique within a product structure.

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

>
{Integer}</SequenceNumber>
34
               <ProductStructure
ProductStructure

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

>
35
                    <ProductStructureId
ProductStructureId

Assignment register identifier

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

>
{Integer}</ProductStructureId>
36
                    <ProductStructureLink
ProductStructureLink

Assignment register identifier

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

>
{String}</ProductStructureLink>
37
               </ProductStructure>
38
               <ProductStructureOperationLink
ProductStructureOperationLink

Product structure operation reference

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

>
{String}</ProductStructureOperationLink>
39
          </ProductStructureOperation>
40
     </ProductStructureAssignment>
41
     <Shipping
Shipping

This field is greyed out because it is an expandable field. You have to add $expand=Shipping in your request URI to get this field

>
42
          <ScheduledShippingDate
ScheduledShippingDate

Shipping date retrieved from the assigned item

This field is greyed out because it is an expandable field. You have to add $expand=Shipping in your request URI to get this field

>
{Date}</ScheduledShippingDate>
43
          <ShippedAt
ShippedAt

Date and time of shipping.

This field is greyed out because it is an expandable field. You have to add $expand=Shipping in your request URI to get this field

>
{Datetime}</ShippedAt>
44
          <RequestedDeliveryDate
RequestedDeliveryDate

Requested delivery date retrieved from the assigned item

This field is greyed out because it is an expandable field. You have to add $expand=Shipping in your request URI to get this field

>
{Date}</RequestedDeliveryDate>
45
          <ConfirmedDeliveryDate
ConfirmedDeliveryDate

Confirmed delivery date retrieved from the assigned item

This field is greyed out because it is an expandable field. You have to add $expand=Shipping in your request URI to get this field

>
{Date}</ConfirmedDeliveryDate>
46
     </Shipping>
47
     <Picking
Picking

This field is greyed out because it is an expandable field. You have to add $expand=Picking in your request URI to get this field

>
48
          <PickStatus
PickStatus

Status of the picking from this assignment. Note that the pick status of the assignment might differ from the status of the pick operation of the assigned item.

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=Picking in your request URI to get this field

>
{Integer}</PickStatus>
49
          <PickedQuantity
PickedQuantity

Total picked quantity of this assignment. Will not get a value before pick operation has started.

This field is greyed out because it is an expandable field. You have to add $expand=Picking in your request URI to get this field

>
{Decimal}</PickedQuantity>
50
     </Picking>
51
     <AssignmentLink
AssignmentLink

Assignment reference

>
{String}</AssignmentLink>
52
</Assignment>
1
{
2
     "assignment": {
3
          "assignmentId
AssignmentId

Allocation identifier

":
"{Integer}",
4
          "quantity
Quantity

Quantity assigned

":
"{Decimal}",
5
          "createdAt
CreatedAt

Date and time of creation

":
"{Datetime}",
6
          "assignedBy": {
7
               "userId
UserId

User identifier

":
"{Integer}",
8
               "userLink
UserLink

User reference

":
"{String}"
9
          },
10
          "assignedTo": {
11
               "database
Database

Database of the object

":
"{String}",
12
               "objectId
ObjectId

Identifier of the object

":
"{Integer}",
13
               "objectType
ObjectType

Type of object

":
"{String}",
14
               "objectLink
ObjectLink

API reference to the object

":
"{String}",
15
               "itemId
ItemId

Item-number of the object

":
"{Integer}",
16
               "itemType
ItemType

Type of item

":
"{String}",
17
               "itemLink
ItemLink

API reference to the item

":
"{String}",
18
               "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

":
"{String}"
19
          },
20
          "productStructureAssignment
ProductStructureAssignment

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

":
{
21
               "productStructureMaterial
ProductStructureMaterial

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

":
{
22
                    "productStructureMaterialId
ProductStructureMaterialId

Product structure material identifier

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

":
"{Integer}",
23
                    "productStructureOperation
ProductStructureOperation

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

":
{
24
                         "sequenceNumber
SequenceNumber

Sequence number of the product structure operation. Unique within a product structure.

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

":
"{Integer}"
25
                    },
26
                    "productStructure
ProductStructure

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

":
{
27
                         "productStructureId
ProductStructureId

Assignment register identifier

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

":
"{Integer}",
28
                         "productStructureLink
ProductStructureLink

Assignment register identifier

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

":
"{String}"
29
                    },
30
                    "productStructureMaterialLink
ProductStructureMaterialLink

Product structure material reference

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

":
"{String}"
31
               },
32
               "productStructureOperation
ProductStructureOperation

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

":
{
33
                    "productStructureOperationId
ProductStructureOperationId

Product structure operation identifier

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

":
"{Integer}",
34
                    "sequenceNumber
SequenceNumber

Sequence number of the product structure operation. Unique within a product structure.

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

":
"{Integer}",
35
                    "productStructure
ProductStructure

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

":
{
36
                         "productStructureId
ProductStructureId

Assignment register identifier

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

":
"{Integer}",
37
                         "productStructureLink
ProductStructureLink

Assignment register identifier

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

":
"{String}"
38
                    },
39
                    "productStructureOperationLink
ProductStructureOperationLink

Product structure operation reference

This field is greyed out because it is an expandable field. You have to add $expand=ProductStructureAssignment in your request URI to get this field

":
"{String}"
40
               }
41
          },
42
          "shipping
Shipping

This field is greyed out because it is an expandable field. You have to add $expand=Shipping in your request URI to get this field

":
{
43
               "scheduledShippingDate
ScheduledShippingDate

Shipping date retrieved from the assigned item

This field is greyed out because it is an expandable field. You have to add $expand=Shipping in your request URI to get this field

":
"{Date}",
44
               "shippedAt
ShippedAt

Date and time of shipping.

This field is greyed out because it is an expandable field. You have to add $expand=Shipping in your request URI to get this field

":
"{Datetime}",
45
               "requestedDeliveryDate
RequestedDeliveryDate

Requested delivery date retrieved from the assigned item

This field is greyed out because it is an expandable field. You have to add $expand=Shipping in your request URI to get this field

":
"{Date}",
46
               "confirmedDeliveryDate
ConfirmedDeliveryDate

Confirmed delivery date retrieved from the assigned item

This field is greyed out because it is an expandable field. You have to add $expand=Shipping in your request URI to get this field

":
"{Date}"
47
          },
48
          "picking
Picking

This field is greyed out because it is an expandable field. You have to add $expand=Picking in your request URI to get this field

":
{
49
               "pickStatus
PickStatus

Status of the picking from this assignment. Note that the pick status of the assignment might differ from the status of the pick operation of the assigned item.

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=Picking in your request URI to get this field

":
"{Integer}",
50
               "pickedQuantity
PickedQuantity

Total picked quantity of this assignment. Will not get a value before pick operation has started.

This field is greyed out because it is an expandable field. You have to add $expand=Picking in your request URI to get this field

":
"{Decimal}"
51
          },
52
          "assignmentLink
AssignmentLink

Assignment reference

":
"{String}"
53
     }
54
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 102190 HTTP 404 Missing mandatory parameter for pick operation id
Error 102187 HTTP 400 Missing mandatory parameter for goods reception database
Error 102188 HTTP 400 Missing mandatory parameter for goods reception id
Error 102189 HTTP 400 Missing mandatory parameter for goods reception item id